Magnum One

home *** CD-ROM | disk | FTP | other *** search

/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d19 / pcbfv21.arc / PCBFV.DOC < prev next >

Wrap

Text File | 1990-11-21 | 73KB | 1,371 lines

------------------------------------------------------------------ | | | | | | | | | | | PCBFV Version 2.1 | | | | PCBoard F V Compressed File Viewer | | | | | | For | | | | PCBoard Version 14.5 | | | | | | * Seamless Interface - Looks Like Part of PCBoard * | | | | | | Allows Text File Reading On-Line | | | | | | Allows Selecting Files For Individual Download | | | | | | | | | | Runs In The F V Shell, As A Door, In PCBFiler, and Locally | | | | | | | | All Options Are Sysop-Configurable | | | | | | | | PCBFV Version 2.1 | | | | (C) Copyright 1990 Yandell Computer Services | | | | 12121 Little Road - Bldg. 303 - Suite 212 | | Hudson, FL 34667 | | | | DATA -- (813) 842-8099 (All nodes HST) | | | | | | November 21, 1990 | | | | | | | ------------------------------------------------------------------ -------------------------------------------------------------------- PCBFV -------------------------------------------------------------------- TABLE OF CONTENTS Page ----------------- ---- INTRODUCTION ------------ 1.0 What Is PCBFV 3 1.1 PCBoard Version Compatibility 3 1.2 What Is New In This Release 3 1.3 Multi-Nodes, Networks, Multi-taskers 3 1.4 Common Installation Mistakes 3 INSTALLING PCBFV IN THE F_V SHELL --------------------------------- 2.0 Determining Memory Requirements 4 2.1 Setting Up PCBVIEW.BAT 4 2.2 Multi-Node Systems and PCBFV.CNF 5 2.3 Upgrading from Previous Versions of PCBFV 5 2.4 Running FVSETUP and Creating PCBFV.CNF 5-9 2.5 PCBFV.HLP Help File (Macros, Color, Etc.) 9 2.6 Limiting (F)lag File Types with FLAG.DAT 10 2.7 Installing an Optional Menu 10 2.8 Managing Caller Created Compressed Files 10 2.9 Sample Configurations 11-12 INSTALLING PCBFV IN OTHER AREAS ------------------------------- 3.0 Installing PCBFV in PCBFiler 13 3.1 Installing PCBFV as a Local Utility 13 3.2 Installing PCBFV as a Door 14 RUN-TIME CONSIDERATIONS ----------------------- 4.0 Notes Regarding the (R)ead Command 15 4.1 Notes Regarding the (S)elect Command 15 4.2 Notes Regarding the (F)lag Command 15 4.3 Notes Regarding the AutoFlag Feature 16 4.4 Notes Regarding "Flagging Across Files" 17 4.5 Notes Regarding the (I)nventory Command 17 4.6 Truncating Long Lines in Text Files 17 MISCELLANEOUS ------------- 5.0 Sysop Function Keys 18 5.1 Technical Notes 18 5.2 Caller Log Entries 18-19 5.3 Error Messages 19 5.4 Where to Receive Assistance 19 5.5 Disclaimer and Warranty 20 5.6 About the Author 20 5.7 Acknowledgments 20 5.8 Revision History 21 5.9 PCBoard single node (/D and /S) and SHARE 21 REGISTRATION ------------ 6.0 Registering PCBFV 21 -------------------------------------------------------------------- Page 3 PCBFV Page 3 -------------------------------------------------------------------- 1.0 What is PCBFV ------------------ PCBFV is a PCBoard BBS utility primarily for use in the F V (File View) shell process. PCBFV may also be installed to run as a door for those systems without sufficient memory to run it in the F V process and which cannot run the PCBoard overlay code or use the "swap to disk on shell" toggle of PCBoard. PCBFV may also be used as the file viewer in PCBFiler. PCBFV displays the contents of .ZIP, .ARC, .PAK .LZH, Lharc SFX .EXE, Lharc SFX .COM, and PKSFX .EXE's. PCBFV will optionally allow a caller to (R)ead text files contained within a compressed file. PCBFV will also optionally allow a caller to (F)lag a compressed file's members for individual downloading. Text (uncompressed) files in a download path may be read by PCBFV. The Sysop has full control over which features of PCBFV are enabled on their system. The goal for PCBFV's development has been to make the caller's interface to the F V process appear as "seamless" as possible. Great emphasis has been placed on making the appearance of PCBFV appear as similar as possible to PCBoard's. 1.1 PCBoard version compatibility ---------------------------------- PCBFV 2.1 has been designed specifically to run with PCBoard version 14.5. PCBFV will not run with earlier versions of PCBoard or with other brands of "BBS" software. 1.2 What is new in this release -------------------------------- PCBFV contains several new and innovative features. Please read the enclosed file FEATURES.NEW for details. 1.3 Multi-nodes, networks, multi-taskers ----------------------------------------- PCBFV has been developed in a networked environment. All multi-node features have been tested on our own multi-node PCBoard system. PCBFV's primary beta test facility is a twenty node system. PCBFV is Desqview aware. It is automatically detected, screen and keyboard I/O are "behaved", and time slices are given back to other applications while PCBFV is idle at an input prompt. Note: the new "AutoFlag" function in this release (2.1) of PCBFV is not available under Desqview. Pertinent multi-node information is highlighted by *MULTI-NODE* throughout this document. 1.4 Common installation mistakes --------------------------------- During the several releases of PCBFV it has been noted that there are areas where mistakes are commonly made during installation. We try to improve the documentation and the installation program (FVSETUP) in subsequent versions to prevent the same mistakes from occurring. The nomenclature *COMMON-MISTAKE* will be used throughout this document to draw attention to those areas where careful installation procedures are required. DO NOT USE A TEXT EDITOR TO MODIFY THE PCBFV.CNF FILE(S). -------------------------------------------------------------------- Page 4 PCBFV Page 4 -------------------------------------------------------------------- 2.0 Determining memory requirements ------------------------------------ There is a "Swap to disk" toggle for all shell processes in both the regular version and the "overlay" versions of PCBoard 14.5. Those systems with minimal memory available to each node (primarily Desq- view operators) will now be able to run PCBFV without concern for limited memory situations. PCBFV takes about 60K and insures another 100K to run the external compression utilities. Figure 2.0 (below) describes the different possibilities for installing PCBoard and PCBFV and the memory requirements of each configuration. ------------------------------------------------------------------ | PCBoard PCBFV & Total | | During Compress. Memory | | F V shell Utilities Needed | | | | PCBoard non-overlay with "swap" on : 5k + 160k = 165k | | PCBoard overlay with "swap" on : 5k + 160k = 165k | | PCBoard non-overlay with "swap" off: 260k + 160k = 420k | | PCBoard overlay with "swap" off : 160k + 160k = 320k | | | ------------------------------------------------------------------ ---- Figure 2.0 ---- The "Total Memory Needed" column indicates the amount of memory needed to run PCBFV in the indicated configuration's (F V) shell. Obviously, the 5k representation indicates how much memory PCBoard is using during the shell process only. The amount of memory PCBoard actually uses with "swap" OFF will vary from system to system. Preloading CNAMES, PCBTEXT, and local scroll back buffers will increase the amount of memory PCBoard actually uses. 2.1 Setting up PCBVIEW.BAT --------------------------- The first line of your PCBVIEW.BAT file(s) should be ECHO OFF or @ECHO OFF, depending on the version of DOS you are using. In your text editor, load PCBVIEW.BAT. The syntax for calling PCBFV is out- lined in figure 2.1 below. ------------------------------------------------------------------ | M:\PCBFV\PCBFV.EXE PCBFV.CNF %1 | | ------------------ --------- -- | | | | |-> PCBoard will replace this with| | | | the compressed file's name. | | | | | | | ---------> The name of the configuration | | | file. Enter a file NAME only. | | | NEVER place a location with name.| | | *MULTI-NODE* see section 2.2 for | | | more information. | | | | | -------> The executable file name. You MUST place it's | | location in-line as shown above if you are not | | putting PCBFV.EXE in each node's \PCB root. | ------------------------------------------------------------------ ---- Figure 2.1 ---- -------------------------------------------------------------------- Page 5 PCBFV Page 5 -------------------------------------------------------------------- 2.2 Multi-Node systems and PCBFV.CNF ------------------------------------- Version 1.1 through 2.01 required the use of a NODE= environment variable in order to use a single PCBFV.CNF file for all nodes. This is no longer necessary. The parameter in FVSETUP for "location of node's root" is also no longer used. To use a single PCBFV.CNF (providing you are using one PCBFV.EXE) for all node's, simply use the @NODE@ macro in two of the FVSETUP parameters. These are "work location of extracted file" and "Loc\name of new (F)lagged file". Otherwise, you will have to create a separate .CNF file for each node and feed PCBFV the individual node's .CNF file in each node's PCBVIEW.BAT. Refer to the "sample configurations section" (section 2.9 page 11, and the section on "Running FVSETUP and Creating PCBFV.CNF" section 2.4 pages 5 thru 9. 2.3 Upgrading from previous versions of PCBFV ---------------------------------------------- All previous versions - Backup your old PCBFV files and replace them with those contained in version 2.1 EXCEPT for PCBFV.CNF file(s). Run the new FVSETUP on your old PCBFV.CNF file(s). It will detect a previous version and "convert" the file for you. New fields which you need to configure will be designated by a flashing asterisk (*) on the screen. These new fields are described below in section 2.4. You should also read through the rest of this document so you will be familiar with how PCBFV works regarding new features. The calling syntax for using PCBFV in PCBFiler and as a Door has changed. Information about both of these installation types may be found on pages 13 and 14. 2.4 Running FVSETUP and creating PCBFV.CNF ------------------------------------------- Enclosed with PCBFV 2.1 is a file called FVSETUP.EXE. This file allows you to easily and quickly configure your PCBFV configuration files. If you run a single node system simply use the PCBFV.CNF file which came with PCBFV and modify it using FVSETUP to your needs. If you run a *MULTI-NODE* installation, you will need to decide if you are going to use a different .CNF file for each node or if you are going to use one .CNF file with @NODE@ macros. To start FVSETUP.EXE, enter FVSETUP PCBFV.CNF at your dos prompt (PCBFV.CNF would be the appropriate node .CNF file). * Idle keyboard time-out (minutes) (and why there is one in PCBFV) ------------------------------------------------------------------ Allows Sysop to set keyboard time-out independent of PCBoard's. If a caller has abandoned their terminal, a time-out will occur in PCBFV and then return them to PCBoard. PCBoard's timer will then start ticking. If you have a large time-out set in PCBoard, it might be a good idea to have a lower one in PCBFV. If the caller is not coming back to the terminal, they will have the combined PCBFV and PCBoard time-outs occur before PCBoard drops them. Section 2.4 continues on the next page -------------------------------------------------------------------- Page 6 PCBFV Page 6 -------------------------------------------------------------------- 2.4 Running FVSETUP and creating PCBFV.CNF (continued) ------------------------------------------------------- * Maximum extracted file size ----------------------------- The maximum uncompressed file size allowed to be extracted for BOTH (R)ead & (F)lag commands. If the file's uncompressed size is larger than what you specify, it may neither be (R)ead if it is text NOR F)lagged for download. You may enter 0 for no limit, however this is not recommended if a RAM drive is used for this parameter. * Work location of extracted file --------------------------------- A "work" location of extracted files for both the (R)ead and (F)lag commands. Whenever a caller (R)eads or (F)lags a file, that file is extracted to the location you specify here. If you have a lot of RAM drive space, it is the ideal place for this parameter. In a *MULTI- NODE* environment, you MUST specify a different "work" directory for each node and indicate that node's directory here. If you are *MULTI-NODE* and are using the single PCBFV.CNF method, place the @NODE@ macro in-line here (C:\WORK@NODE@\). PCBFV never deletes work directories. It simply insures the appropriate work directory exists each time it is run, and creates it if not. If you nest your work subdirectories, PCBFV will only try to create the "last" directory in the nest. For example, if your work location is C:\PCB\PCBFV\WORK then PCBFV will only attempt to create \WORK. IF C:\PCB\PCBFV didn't exist PCBFV will report it couldn't make the work directory. In these cases, you will need to create the work locations manually. * Path to compression utilities ------------------------------- Enter ONLY the path of your compression utilities. Do NOT enter a file name in this parameter. This parameter allows PCBFV to go directly to your compression utilities, rather than search your path for them. This results in faster overall extraction/compression response time. Again, DO NOT ENTER A FILE NAME in this parameter, ONLY a drive and directory location. PCBFV will expect to find the following compression utilities - PKZIP and PKUNZIP (ver 1.10) for ZIP and PKSFX EXE files. PKPAK and PKUNPAK (ver 3.61) for ARC files. PAK (tested with ver 2.01) for PAK files (for (R)ead only). LHARC ver 1.14 for LZH and LHarc SFX .EXE and SFX .COM files. * Disable (R)ead text option ---------------------------- Allows the Sysop to disable the (R)ead text function of PCBFV. If disabled, the (R) command should be removed from PCBFV.HLP. * Security needed to (R)ead files (Introduced in 2.0) ----------------------------------------------------- Enter the minimum security level needed for a caller to be able to read text in a compressed file. Sysops may want to prohibit new callers, non-subscribing callers, etc. from using this feature. Not available on SINGLE node versions (/S and /D) if SHARE is loaded. Section 2.4 continues on the next page -------------------------------------------------------------------- Page 7 PCBFV Page 7 -------------------------------------------------------------------- 2.4 Running FVSETUP and creating PCBFV.CNF (continued) ------------------------------------------------------- * Maximum lines to read per file -------------------------------- Enter 0 for no limit, or a limit up 9999. This will limit the number of lines in EACH text file a caller can read. Some Sysops would rather caller's not read entire text files on-line. Less scrupulous callers might use the (R)ead function to screen cap text files and avoid file or byte download ratios which may be in effect. When setting this, remember that some authors don't get around to describing what their software does until 10 or 20 pages (screens) into the documentation. Between 400 and 500 is a good MINIMUM limit. * Disable wildcard (R)ead request (Introduced in 1.1) ----------------------------------------------------- Allows the Sysop to disable the wildcard file name searches when requesting text files to (R)ead. Wildcard read request was a new feature introduced in version 1.1. * Y/N/A prompt for wildcard find (Introduced in 2.0) ---------------------------------------------------- You may specify PART of the Yes/No/Abort prompt which appears for each filename that matches a wildcard (R)ead request. The prompt displayed in version 1.1 when a matching wildcard file was found was not informative enough. Since so many different suggestions were received as to what it should be, it was decided to allow each Sysop to configure it to their needs. Note: the (Y) added to the end of the prompt will always appear. (Next: PCBFV.DOC Size: 37793) (H)elp, Read this file? (Y) | | |_____________________| | | What you place in this parameter will be inserted here. Suggestions: (H)elp, Read this file? (H)elp, Read this file (Yes,No,Abort)? (H)elp, Read this file (Enter)=Yes? * Disable (S)elect file option (Introduced in 2.0) -------------------------------------------------- Allows the Sysop to disable the "(S)elect another compressed file" option. Starting with PCBFV 2.0 is the ability to select another compressed file for viewing without exiting the F V shell (or without returning from PCBFV if used as a door). The (S)elect command improves the caller interface to the file view process, as the caller is not returned back and forth to PCBoard if they have several files to view. The details of this function are explained in section 4.1 page 15 of this document. Section 2.4 continues on the next page -------------------------------------------------------------------- Page 8 PCBFV Page 8 -------------------------------------------------------------------- 2.4 Running FVSETUP and creating PCBFV.CNF (continued) ------------------------------------------------------- * # files in each (F)lagged file (CHANGED in 2.0) ------------------------------------------------- Allows the Sysop to specify the number of files (1-99) that can be added to the file which contains each individually flagged file. Entering 0 (zero) disables the (F)lag function. If (F)lag is disabled, the (F) and (I) commands should be removed from PCBFV.HLP. * Security needed to (F)lag files (Introduced in 2.0) ----------------------------------------------------- Enter the minimum security level needed for a caller to be able to (F)lag separate files within compressed files for downloading. Sysops may want to prohibit new callers, non-subscribing callers, etc. from using this feature. Not available on SINGLE node versions of PCBoard (/S and /D) if SHARE is loaded. PCBoard locks the USERS file on /D and /S versions if SHARE is loaded, making it impossible for PCBFV to retrieve the caller's security level (see section 5.9). * Loc\Name of new (F)lagged file -------------------------------- If (F)lag is allowed, enter the location AND name of the file which will be created and will contain the individual files the caller selects for downloading. The location MUST be a drive and path which are listed in your DLPATH.LST!!! The .EXT you place on the filename determines the compression method used by PCBFV to create the file. In a *MULTI-NODE* environment, the file NAME in the above parameter MUST be different for each of your nodes. You may accomplish this by either placing a different name in each node's .CNF file, or if you are using a single PCBFV.CNF then place the @NODE@ macro in-line here (C:\UPLOAD\FLAG-@NODE@.ZIP). NOTE: Do not use PAK as the file extension here unless you are using PCBoard's "Swap" memory method for shelling *OR* you are using PCBFV as a door. PAK works fine with the (R)ead function but is very memory hungry while creating .PAK files. *COMMON-MISTAKE* - Creating a new directory to hold FLAGGED files, and not placing that location in PCBoard's DLPATH.LST and/or FSEC. * Disable (F)lagging across files (Introduced in 2.0) ----------------------------------------------------- Callers may flag files from different compressed files without having to download the flagged file after each file view. You may disable this feature. This feature is explained in detail in section 4.4 page 17 of this document. * Disable AutoFlag on PCB return (NEW in version 2.1) ----------------------------------------------------- When PCBFV terminates the F V session and returns control to PCBoard, it will prompt PCBoard to place the caller created flagged file into PCBoard's own FLAG list (if the caller has flagged separate files in PCBFV). This parameter allows you to disable this feature. Refer to section 4.3 page 16 for details on "AutoFlag". Note: The AutoFlag function is turned off by PCBFV if running under Desqview regardless of this setting. Section 2.4 continues on the next page -------------------------------------------------------------------- Page 9 PCBFV Page 9 -------------------------------------------------------------------- 2.4 Running FVSETUP and creating PCBFV.CNF (continued) ------------------------------------------------------- * Your PCBFV registration number -------------------------------- This is the registration number you will receive when you register PCBFV. All functions are enabled in an unregistered version. Registration causes the PCBFV [ UNREGISTERED COPY ] message and the brief two second delay at program termination to disappear. This message is not replaced with your board name or anything else. The entire line completely disappears for a true, seamless, "looks like PCBoard" process whether running in the F V shell or as a door (see the enclosed file ORDER.FRM). * Main prompt (Introduced in 2.1) --------------------------------- You may change PCBFV's main command prompt. If PCBoard's prompts are significantly changed, PCBFV actually won't live up to it's "looks like part of PCBoard" claim unless this prompt is changed also. The default "(H)elp, File View Command?" is now supplied. You may want to insert the command letters or command abbreviations: (H)elp, (L), (R), (S), (F), (I), File View Command? (H)elp (L)ist (R)ead (S)el (F)lag (I)nv File View Command? It is recommended you at least stay with the PCBoard convention of beginning the prompt with (H)elp. Don't include any command letters if they are disabled in your configuration of PCBFV. 2.5 PCBFV.HLP help file (macros, color, etc.) ---------------------------------------------- PCBFV.HLP is a very important part of PCBFV. It is very likely that every caller will want (H)elp, at least the first time they use PCBFV. There are two very important @macros@ used by PCBFV.HLP. These are PCBFV's own macros and are described below. @FILENAME@ - Whenever this appears in PCBFV.HLP, PCBFV will replace it with the file name that is currently being viewed. @FLAGFILE@ - Whenever this appears in PCBFV.HLP, PCBFV will replace it with the name of the compressed file which will be created when a caller Flags files for separate download. This feature is especially helpful for *MULTI-NODE* systems, since a different compressed file name is mandatory for each node. @FLAGFILE@ will be replaced by that node's file name as it appears in that node's .CNF file thereby creating the need for only one help file. PCBFV.HLP allows color by utilizing the color macro scheme devised by PCBoard 14.5. In fact, actual ANSI graphics will not work in PCBFV.HLP. Since PCBFV is part of a PCBoard shell process, it was desirable to keep PCBFV as small as possible. ANSI capabilities in the external help file were intentionally omitted. Review PCBFV.HLP and remove any commands you may have disabled. PCBFV.HLP must reside in the same location with PCBFV.EXE. -------------------------------------------------------------------- Page 10 PCBFV Page 10 -------------------------------------------------------------------- 2.6 Limiting (F)lag file types with FLAG.DAT --------------------------------------------- You may limit (F)lagging activity to certain types of files. With your text editor, create a file called FLAG.DAT in the same location with PCBFV.EXE. Simply begin entering COMPLETE or WILDCARD file names of those files which you wish the caller to be able to flag. Enter (RETURN) after each name so that each entry is on a new line. If FLAG.DAT is not present, no limitations are placed on Flag names. See figure 2.6 below for examples of names in FLAG.DAT. ------------------------------------------------------------------ | Good examples Bad examples | | ------------- ------------ | | *.DOC PCBFV uses regular DOS .DOC | | *.TXT wildcard specs to see if .TXT | | READ*.* a file is a match. If so, READ | | *.NEW the file may be flagged. .NEW | | FILE.CFG FILE* | ------------------------------------------------------------------ ---- Figure 2.6 ---- 2.7 Installing an optional menu. --------------------------------- The Sysop may create a "menu" which will be displayed before PCBFV's command prompt each time the prompt is displayed. This should be a simple text file called "MENU" and may contain PCBoard style color macros and PCBFV's two custom macros (see PCBFV.HLP). This file must reside in the same location with PCBFV.EXE. If this file does not exist PCBFV simply shows it's main prompt. PCBFV's main prompt may be customized if the Sysop does not wish to add a menu. 2.8 Managing caller created compressed files --------------------------------------------- Each time PCBFV runs it checks for the presence of a caller created flagged file. If the file exists and the Sysop has DISABLED the "Flag across files" function, the file will be deleted. If "Flag across files" is allowed, an information file (created by PCBFV, explained in detail in section 4.5 page 17) is checked to see if the same caller executing the view is the same caller who created the current Flagged file. If so, the flagged file is kept for additional flagging, if not the caller created flagged file is deleted. For those of you concerned about a leaving a caller created file on the drive, there are a couple of things which you can do to assist PCBFV in it's housekeeping chores. Set PCBoard to recycle to DOS after each call, then place the following line in BOARD.BAT: if exist c:\location\filename.ext del c:\location\filename.ext (Replace C:\LOCATION\FILENAME.EXT with the appropriate information you gave this node with FVSETUP for "Loc\Name of flagged file".) You may also place the above in your EVENT.SYS which will delete the caller created flagged file each time your event runs. Refer to the PCBoard manual for instructions and details regarding the "Cycle to DOS after each call" setting and modifying EVENT.SYS. -------------------------------------------------------------------- Page 11 PCBFV Page 11 -------------------------------------------------------------------- 2.9 Sample configurations -------------------------- [Single node] ------------- C:\PCB ------ PCBVIEW.BAT - contains PCBFV.EXE PCBFV.CNF %1 PCBFV.EXE PCBFV.CNF PCBFV.HLP You may prefer this alternate single node configuration C:\PCBFV (or the location of your choice) -------- PCBFV.EXE PCBFV.CNF PCBFV.HLP C:\PCB ------ PCBVIEW.BAT - contains C:\PCBFV\PCBFV.EXE PCBFV.CNF %1 [*MULTI-NODE*] ------------------------------------------------------------- [Example 1 (all nodes on server) (using a single PCBFV.CNF file)] Your multi-node PCBFV.CNF would look something like this: Idle keyboard time-out (minutes) : 3 Maximum extracted file size : 250000 Work location of extracted file : C:\WORK@NODE@\ Path to compression utilities : C:\UTILS\ Disable (R)ead text option : N Security needed to (R)ead files : 0 Maximum lines to (R)ead per file : 0 Disable wildcard (R)ead input : N Y/n/a prompt for wildcard find : (H)elp, Read this file? Disable PCBFV (S)elect option : N # files in each (F)lagged file : 10 Security needed to (F)lag files : 0 Loc\Name of new (F)lagged file : C:\UPLOAD\FLAG@NODE@.ZIP Disable (F)lagging across files : N Disable AutoFlag on PCB return : N Your PCBFV registration number : 1 Main prompt : (H)elp, File View Command? ONLY edit PCBFV.CNF files with the enclosed FVSETUP utility. Section 2.9 continues on the next page -------------------------------------------------------------------- Page 12 PCBFV Page 12 -------------------------------------------------------------------- 2.9 Sample configurations (continued) -------------------------------------- If you cannot use the single file PCBFV.CNF method you will need to make a configuration file for each node and place the different configuration file name in each node's PCBVIEW.BAT. This would likely be the case if all of your nodes are not on a common server. [Sample - node 1 (using separate PCBFVx.CNF files)] Idle keyboard time-out (minutes) : 3 Maximum extracted file size : 250000 Work location of extracted file : C:\WORK1\ Path to compression utilities : C:\UTILS\ Disable (R)ead text option : N Security needed to (R)ead files : 0 Maximum lines to (R)ead per file : 0 Disable wildcard (R)ead input : N Y/n/a prompt for wildcard find : (H)elp, Read this file? Disable PCBFV (S)elect option : N # files in each (F)lagged file : 10 Security needed to (F)lag files : 0 Loc\Name of new (F)lagged files : C:\UPLOAD\FLAG1.ZIP Disable (F)lagging across files : N Disable AutoFlag on PCB return : N Your PCBFV registration number : 1 Main prompt : (H)elp, File View Command? [Sample - node 2 (using separate PCBFVx.CNF files)] Idle keyboard time-out (minutes) : 3 Maximum extracted file size : 250000 Work location of extracted file : C:\WORK2\ Path to compression utilities : C:\UTILS\ Disable (R)ead text option : N Security needed to (R)ead files : 0 Maximum lines to (R)ead per file : 0 Disable wildcard (R)ead input : N Y/n/a prompt for wildcard find : (H)elp, Read this file? Disable PCBFV (S)elect option : N # files in each (F)lagged file : 10 Security needed to (F)lag files : 0 Loc\Name of new (F)lagged file : C:\UPLOAD\FLAG2.ZIP Disable (F)lagging across files : N Disable AutoFlag on PCB return : N Your PCBFV registration number : 1 Main prompt : (H)elp, File View Command? ONLY edit PCBFV.CNF files with the enclosed FVSETUP utility. As you can see, PCBFV is very flexible in the way it may be installed, and you will be able to install it in any configuration of PCBoard. -------------------------------------------------------------------- Page 13 PCBFV Page 13 -------------------------------------------------------------------- 3.0 Installing PCBFV in PCBFiler --------------------------------- The "PCBFiler" mode of PCBFV has been greatly enhanced over previous versions. A /L parameter is now used (shown below) which tells PCBFV it is operating in a "true" local mode. All normal "on-line" functions are disabled, such as keyboard time-out, the caller status line at the bottom of the screen, etc. Screen mode is detected and color is used if appropriate. Special Note: If you are installing PCBFV in PCBFiler and are using PCBFV.CNF files with the @NODE@ macro in them, you must place a SET NODE= variable in the environment on the machine you are using PCBfiler with. This is the ONLY time a SET NODE= setting is needed for the @NODE@ macros used in PCBFV.CNF to work. All on-line installations of PCBFV use the actual node number from PCBOARD.DAT to replace the @NODE@ macro. Since PCBOARD.DAT is not read in the /L local mode of PCBFV, the SET NODE=x setting is used to determine the appropriate replacement for @NODE@. At PCBFILER's first screen select "Edit PCBFILER defaults page 2". At the bottom of this screen, enter parameters as follow: File VIEWERS - filename extensions and commands for executing viewer File Extension : ZIP DOS Command : c:\pcb\PCBFV PCBFV.CNF /L File Extension : ARC DOS Command : c:\pcb\PCBFV PCBFV.CNF /L File Extension : PAK DOS Command : c:\pcb\PCBFV PCBFV.CNF /L File Extension : LZH DOS Command : c:\pcb\PCBFV PCBFV.CNF /L New in version 2.1 is the /L parameter providing a true local mode. All other areas of this documentation apply to PCBFV installation. For each compression type (which PCBFV is compatible with) place the "DOS Command :" entry as above. The parameters must be places in the same order as they are shown in the examples: Name\location of PCBFV.EXE, configuration file, then /L. The (S)elect command and all function keys are disabled in this mode. All other sections in this documentation apply to installing PCBFV in PCBFiler. 3.1 Installing PCBFV as a local utility ---------------------------------------- Create a batch file called FV.BAT or whatever name you like and place the following command in it: C:\PCB\PCBFV PCBFV.CNF /L %1 Place FV.BAT (or whatever you call it) in your DOS path, and you have a full powered viewer, extractor at your fingertips at all times by typing FV FILENAME.ZIP (extension IS required in this mode). All other areas of this manual apply to this installation method, particularly those involved with setting up PCBFV.CNF. -------------------------------------------------------------------- Page 14 PCBFV Page 14 -------------------------------------------------------------------- 3.2 Installing PCBFV as a door ------------------------------- This capability exists mainly as an option in case a Sysop is unable to utilize the F V Shell. The documentation for installing PCBFV as a door is almost the same as installing it in the F V shell. For door installation, simply follow the instructions below INSTEAD of those found in sections 2.0 and 2.1. All other sections apply to door installation. Install a door called FV in DOOR.LST file with PCBSETUP. Place this entry at the end of DOOR.LST, as the recommended usage calls for invoking PCBFV as a door by name (FV), rather than the conventional way of placing it in your door menu and calling it by number. Answer NO to the USER.SYS and DOOR.SYS parameters. Create a door (batch) file called FV where you keep your door files: @echo off SET PCBFV=DOOR M:\PCBFV\PCBFV.EXE PCBFV.CNF C:\PCB SET PCBFV= --------- ------ board | |__Location of THIS node's PCB root |__ PCBFV configuration file. Is imperative that you place the SET PCBFV=DOOR and SET PCBFV= before and after calling PCBFV as a door as shown. Notice that we didn't change drive and/or cd\ to the PCBFV location. Instead, we called it directly from where FV is run because of PCBFV's ability to do this. This results in faster load time. If, however, you are running *MULTI-NODES* and each node is residing on a different drive, you may find it faster to install PCBFV as a door on each node's drive. Make sure your menus reflect the FV command instead of F V. PCBFV (as a door) can be passed a filename from the PCBoard command prompt, the same way the F V shell process passes a file, for example "FV TEST.ZIP". This requires no extra installation by the Sysop and is handled automatically by PCBoard and PCBFV. The main benefit of running PCBFV as a door is that it can be run on any system regardless of memory constraints. The drawbacks of running PCBFV in the door mode are slower loading speeds, and the caller interface is not quite as seamless as with the shell mode. If you are truncating long lines (see section 4.6 page 17) change the first SET command in the door file to: SET PCBFV=DOOR TRUNCATE. -------------------------------------------------------------------- Page 15 PCBFV Page 15 -------------------------------------------------------------------- 4.0 Notes regarding the (R)ead command ----------------------------------------- When a caller selects a file to read from within a compressed file, the file is tested to see if it is a text file suitable for on-line display. The first test simply checks the file's name extension and if the extension is NOT commonly associated with text files (EXE, COM, ZIP, ARC, and several others) then the file will not be displayed. If the file passes that test, a portion of the file is analyzed to see if contains characters that typically only appear in binary (non-text) files or if it contains carriage-return line-feed sequences. If the file contains characters usually only found in binary files, or if there are no carriage-return line-feed sequences the file will not be displayed to the caller. PCBFV tests text files for ANSI escape sequences and form feeds. If either are found PCBFV suppresses them before displaying the text. 4.1 Notes regarding the (S)elect command ----------------------------------------- PCBFV's (S)elect command is completely conference DLPATH.LST aware. The caller will only be able to (S)elect files to view which are available to the conference they are in (or last in, if using PCBFV as a door). PCBFV's (S)elect command is also completely FSEC aware. When a (S)elect request is found, PCBFV checks FSEC to insure the caller has security to view the file. If the file is password protected, PCBFV will also ask the caller the password, and performs this operation in the same manner as PCBoard. PCBFV uses the "Filename EXTENSION for compressed files" entry in PCBSETUP as the default filename extension when performing it's own file searches. 4.2 Notes regarding the (F)lag command --------------------------------------- The System Administrator/Operator may specify what type of files the caller may flag (see section 2.6 FLAG.DAT). A security level may be attached to this command. Callers may "flag across files" (see section 4.4 below). There is an (I)nventory command, and the inventory information file is automatically included in each caller created file. Files which are (F)lagged for individual download are automatically placed in the compressed file designated for the node the caller is on. The extracted member is then deleted from the work directory. This keeps the amount of disk space PCBFV is requiring down and allows a RAM drive to be used as a work location, which greatly speeds up execution of the program. Regardless of how PCBFV is installed, the caller will never be able to include ALL of the files from a compressed file into their caller created file. In all cases, the caller at best will be able to include all but ONE file into their flagged file. For instance, if you set PCBFV to allow 5 files for inclusion into the caller created file, and the caller is viewing a compressed file with 4 files, the most they will be able to flag of those is 3 of the 4. The theory behind this is the caller should download the actual file rather than flagging each individual file. -------------------------------------------------------------------- Page 16 PCBFV Page 16 -------------------------------------------------------------------- 4.3 Notes regarding the AutoFlag feature ----------------------------------------- This is an all new feature of PCBFV 2.1. If the Sysop has allowed this feature in FVSETUP, PCBFV will cause PCBoard to think the caller has entered instructions to "FLAG" the caller created flagged file as part of PCBoard's own "FLAG" list. PCBoard will remind the caller of the existence of their "flagged" file in the "batch" when the caller enters "D" from PCBoard, logs off without downloading their batch list, etc. How it works: For the purposes of this example, we'll say the name of the caller created file in PCBFV is called FLAGGED.ZIP. PCBFV actually "types in" FLAG FLAGGED just before turning control back over to PCBoard at the end of the F V shell. PCBoard then acts on these instructions as if they were entered by the caller. While FL could could have been used (instead of FLAG) it was felt the use of the entire FLAG command (which IS displayed on the remote AND host screens) would give the caller a better indication of what had just (automatically) happened. Note the extension (.ZIP) is NOT used and will not appear, but will be appended to the file search by PCBoard. There is a hardware limitation on the number of characters which PCBFV can "type in", and removing the extension allows this feature to function. Operational notes: If "flagging across files" and AutoFlag are both enabled and it is the first F V session, AutoFlag will occur. On subsequent F V sessions, if the caller Flags (in PCBFV) separate files they will be asked if they've downloaded FLAGGED.ZIP yet (since/if you allow flagging across files, PCBFV has no way of knowing). If they answer Yes, PCBFV will AutoFlag again at the end of the current F V session. If they answer No, PCBFV won't perform AutoFlag. If the caller answers No, and they really have downloaded FLAGGED.ZIP, then AutoFlag won't occur (since they answered No) and the file will not be placed in PCBoard's FLAG list. Subsequently, if the caller answers Yes they downloaded FLAGGED.ZIP but really didn't PCBFV will AutoFlag the caller created (FLAGGED.ZIP) file. Since the the caller really didn't download (in this scenario) it will still exist in PCBoard's FLAG batch list, and the caller will receive: (@OPTEXT@) duplicates a file already in the batch! This is record #554 in PCBTEXT. Changing it to something like: (@OPTEXT@) exists in the batch list... is recommended as it sounds less like an error message, and is still informative if the caller DBs or FLAGs a duplicate d/l file from PCBoard. The @optext@ in the above examples is replaced with the appropriate caller created flagged file name (FLAGGED.ZIP, etc.) The download path(s) which contain your FLAGGED.ZIP (or FLAG1.ZIP FLAG2.ZIP etc.) should be placed at the beginning of DLPATH.LST so PCBoard's FLAG search occurs as quickly as possible when returning from the F V shell. The AutoFlag function is automatically disabled if Desqview is detected. -------------------------------------------------------------------- Page 17 PCBFV Page 17 -------------------------------------------------------------------- 4.4 Notes regarding "flagging across files" -------------------------------------------- If you allow the caller to "flag across files", this means they will be able to view a compressed file, select files from it to download individually, then view another compressed file and select individual files from it, adding all of the individual files to one caller created file for downloading. The number which you place in the "# files in each (F)lagged file" parameter in FVSETUP will be observed, even when flagging across files is allowed. If a caller should select an individual filename which is identical in two different compressed files, the caller will be given the choice of which one to keep in the "caller created compressed file", as obviously a compressed file cannot contain two files with the same name. For systems that enforce download file counts, you need to be aware that if you allow "flagging across files" and you also place a high number in the "# of files in each (F)lagged file" parameter in FVSETUP, unscrupulous callers might be able to use it to "beat the system". In most cases. placing a low number in the FVSETUP field "# of files in each (F)lagged file" will prevent this undesirable effect. Also, using FLAG.DAT (see section 2.6) to limit the types of names of files that can be flagged, in conjunction with a low number allowed in each caller created file, will surely thwart this activity. In all cases, disabling "flagging across files" will eliminate the need for concern completely. 4.5 Notes regarding the (I)nventory command -------------------------------------------- This command allows the caller to take inventory of their current "Flag file". They will be shown the contents which will consist of a list of the individual files they have flagged, the compressed file name which the individual files came from, and the size in bytes of the "Flag file" they have created. The file containing the information shown by the (I) command is created by PCBFV in each node's work directory you have assigned it. This file is also automatically included in the "Flag file" the caller will download, so that the caller will have a reference as to which individual files came from which compressed files. The (I)nventory command is disabled if the (F)lag command is disabled. 4.6 Truncating long lines in text files ---------------------------------------- Some institutions carry ZIP (or other form of compressed) files which contain text typically formatted in 132 columns, usually used for reports on 14 inch greenbar paper. In some situations the Sysop advises callers to "File View" the compressed file to verify it is the report the caller wants. However, the text past column 80 in each line has always been "wrapped" to the next line, which may make reading the text difficult. Some Sysops may wish to truncate this text and lose the last 40 or so characters rather than have it "wrap". In order to do this, simply place a set command in each node's AUTOEXEC.BAT file. This set command is SET PCBFV=TRUNCATE. Running PCBFV in this mode is not recommended unless most of the files on your system are text files with over 80 columns per line. -------------------------------------------------------------------- Page 18 PCBFV Page 18 -------------------------------------------------------------------- 5.0 Sysop function keys ------------------------ PCBFV follows F3 (printer on/off), F7 (alarm on/off) and F9 (display on/off) toggles from PCBoard. If F3 is on, PCBFV will print any information sent to the caller log to the printer also. If F7 is on, PCBFV will beep locally (usually caller input errors). If F9 is off, PCBFV will turn the screen off. Pressing any key locally turns the screen on if F9 is active. You may toggle these three function keys on or off. Their status will be displayed on the command line in parenthesis (PAB). Note: toggling an option on or off is local to the PCBFV process only, since PCBoard does not read PCBOARD.SYS when returning from a File View. When PCBFV returns control to PCBoard, the toggles will be in the same state as before the File View shell. Note: the B displayed in (PAB) is the F4 page bell indicator. This is shown on PCBFV's status line for information purposes only (if page was allowed in PCBoard before the File View). 5.1 Technical notes -------------------- Carrier is monitored by PCBFV. Should a caller drop carrier while in PCBFV they will be returned to PCBoard, which will detect the "no carrier" status and cycle appropriately. PCBFV works with non-standard com ports ,addresses, and IRQs. COM1 is address 3F8/IRQ 4. COM2 is address 2F8/IRQ 3. If a COM port other than 1 or 2 is used, PCBFV will use the address and IRQ as indicated in PCBOARD.DAT for the node. 100K of memory is needed after PCBFV loads for calling compression utilities. PCBFV will "turn off" Flag and Read if memory drops below this level. 170K of memory is needed for flagging IF you are making the caller created flagged file a .LZH file. PCBFV will turn off Flagging (not Reading) if memory is below 170K and the caller created file is a .LZH file. PCBFV checks for adequate disk space before attempting to extract a file for (R)eading or (F)lagging. 5.2 Caller log entries ----------------------- PCBFV makes pertinent entries into the caller log as outlined below. If the (F)lag command is enabled, PCBFV will make the following entry in the caller log when a file is flagged: FILENAME.DOC in FILENAME.ZIP flagged for download PCBFV will make the following entries in the caller log to alert the Sysop of inadequate disk space: Insufficient disk space to Read FILENAME.TXT Insufficient disk space to Flag FILENAME.TXT Section 5.2 continues on the next page -------------------------------------------------------------------- Page 19 PCBFV Page 19 -------------------------------------------------------------------- 5.2 Caller log entries (continued) ----------------------------------- If the (S)elect command is enabled, PCBFV will make the following entries in the caller log if the corresponding event occurs: View executed on file (FILENAME.ZIP) Error executing View of file (FILENAME.ZIP) (FILENAME.ZIP) not found! Insufficient security for Viewing (FILENAME.ZIP) Incorrect View Password for File (FILENAME.ZIP) (123456789.ZI) is an invalid filename! The caller log entries for the (S)elect command are identical to the corresponding default entries in PCBoard's PCBTEXT. If AutoFlag is enabled, and PCBFV is unable to verify the buffer holding the AutoFlag instructions after three attempts, the buffer will be cleared and "Unable to perform PCBFV AutoFlag function!" will be written to the caller log. 5.3 Error messages ------------------- PCBFV gives verbose installation error messages, such as invalid paths and file names you may have placed in PCBFV.CNF. These messages appear and there is a short pause while they are displayed. PCBoard erases the screen after a F V shell and this short pause will allow you to see the message. The following are explanations of PCBFV's run time error messages: * Error extracting file (1) * This means that the file selected for (R)eading or (F)lagging already existed in the work directory designated for this node. As a safety precaution, PCBFV will not overwrite a file which already exists in a work directory. * Error extracting file (2) * This indicates the file appears in the compressed file, but for some reason the extraction utility could not extract it. This could possibly mean PCBFV was unable to find the extraction utility needed. * bad command or filename * This is a DOS error message indicating that PCBVIEW.BAT could not find PCBFV.EXE, or PCBFV.EXE could not find the appropriate extraction utility. 5.4 Where to receive assistance -------------------------------- There are two ways to receive assistance should it be needed. The Bounty, Home of PCBFV 813-842-8099 All nodes HST --------------- Sound Advice Information Services 816-436-4516 HST 816-436-8029 Hayes Sound Advice is available through PC Pursuit and StarLink networks. Leave a message to Brent Yandell in the YANDELL conference, currently #10 on Sound Advice. Please understand that while we call Sound Advice regularly, we do not call there everyday. If your need for assistance is urgent, please direct the matter to the number listed as the "Home of PCBFV". -------------------------------------------------------------------- Page 20 PCBFV Page 20 -------------------------------------------------------------------- 5.5 Disclaimer and warranty ---------------------------- PCBFV is a shareware product. PCBFV may be uploaded to BBS systems as long as copyright notices are not removed and no changes are made to the program. There are no warranties, expressed or implied, for unregistered copies of PCBFV. Sysops who install PCBFV on their systems assume any and all liabilities for anything which may result as a consequence of running PCBFV. For registered copies of PCBFV, Yandell Computer Services warrants that PCBFV will perform as described in this documentation. In the event that PCBFV does not perform as specified, then Yandell Computer Services may elect to fix PCBFV or refund the amount paid, if notified within 30 days of registration. Operations and functions concerning LHarc .LZH files and and LHarc SFX .EXE and .COM files are not covered in this warranty. Under no circumstances shall Yandell Computer Services or the author of PCBFV be liable for any loss of profit or any other damages, including but not limited to special, incidental, consequential, or other damages, arising out of the use or inability to use PCBFV. PCBoard is a registered trademark of Clark Development Co. Inc. DESQview is a registered trademark of Quarterdeck Office Systems 5.6 About the author --------------------- L. Brent Yandell has been involved in telecommunications for over four years. Many Sysops will be familiar with BBSQBASE, a popular door which has been in existence, supported, and updated for over three years. 5.7 Acknowledgments -------------------- Appreciation and many thanks are in order for the following people: David Terry of Clark Development Co. for making available the process of updating PCBOARD.SYS before a File View, for allowing PCBFV to update the caller log in the file view shell, and for ongoing technical advice during PCBFV's development. Roy Timberman of Sound Advice Information Systems for making his twenty node system completely available for testing PCBFV, and for providing a conference area for supporting PCBFV as well as our other offerings. Jeff Sumberg, author of the communications library used in PCBFV. Jim Brewer for assembler technical advice and documentation review. Tim Yandell for editing and proofing this documentation. Many thanks to all of the version 2.1 "wide area" beta testers. A special thanks to Mike Hatala and Robert York for beta testing above and beyond the call of duty. -------------------------------------------------------------------- Page 21 PCBFV Page 21 -------------------------------------------------------------------- 5.8 Revision history --------------------- Date Version Details -------- ------- ------- 07-19-90 1.0 PCBFV First Released 08-02-90 1.1 Added wildcard (R)ead ability, ability to use one PCBFV.CNF file for multi-node systems, at the "More?" prompt the percentage of the text file that has been read is displayed. 10-19-90 2.0 See the enclosed file FEATURES.NEW. 10-21-90 2.01 Minor maintenance release to version 2.0. 11-21-90 2.1 See the enclosed file FEATURES.NEW. 5.9 PCBoard single node (/D and /S) and SHARE ---------------------------------------------- PCBoard apparently performs an exclusive file lock on the USERS file of SINGLE node versions (/D or /S) when SHARE is loaded. This makes it impossible for PCBFV to determine the caller's security. Under this circumstance, limiting the (R)ead or (F)lag functions based on security is not possible. If the USERS file cannot be read, any values placed in the security fields for (R)ead and (F)lag are ignored. Additionally, the "Times On" and "Sec (level)" fields on the status line will indicate "N/A" for not available, and the "Last Date On" (status line lower left) will be blank. This is not a problem with PCBoard or PCBFV. PCBoard /D /S is single node software and is not designed to share critical files with another process. PCBoard is only acting appropriately when opening these critical files in a SINGLE node environment where SHARE is loaded. 6.0 Registering PCBFV ---------------------- PCBFV is not free software. Refer to the enclosed file ORDER.FRM for all registration details.